Skip to content

PWMoutputMATLABtutorial #222

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 91 commits into from
Aug 24, 2022
Merged

PWMoutputMATLABtutorial #222

merged 91 commits into from
Aug 24, 2022

Conversation

MessiahJa
Copy link
Contributor

This a contribution. While I will be completing the tutorial based on the guidelines (such as adding the "Ciruit" section), I have a few questions:

  • Should I convert and upload all images as 1920x1080 png? Or will you be providing the images with a certain theme?
  • The introduction for MATLAB was taken from the nanoMatlabWiFiLED tutorial. Should it be changed and merged into a part of the main section of the tutorial?

Contribution Guidelines

@CLAassistant
Copy link

CLAassistant commented May 11, 2022

CLA assistant check
All committers have signed the CLA.

Copy link
Contributor

@jhansson-ard jhansson-ard left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@MessiahJa thank you for your contribution! I made a small QA and was mainly focusing on the trademarks and formatting of your tutorial.

Please take a look and let me know what you think. If you agree (which you should at least with the trademarks), please use the "commit suggestion" button to implement my suggestions!

@jhansson-ard
Copy link
Contributor

jhansson-ard commented May 11, 2022

Then, to answer your questions.

  1. Yes, please do make sure all your images are in the format 1920x1080. If you are using external images, try using images or format them in some way that they also follow the guidelines. If you are using other people's images, you need to make sure if follows the correct copyrights. Your images look fine, and we don't need to remake them!
  2. If the introduction still makes sense, you can leave it. However if it is somehow different from the tutorial you copied, please add a sentence or two about what your tutorial is about.

again, thank you for your contribution! ⭐

Copy link
Contributor Author

@MessiahJa MessiahJa left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'll retake the screenshots in 1080.

@per1234
Copy link
Contributor

per1234 commented May 13, 2022

Hi @MessiahJa. Please sync your fork by following this tutorial:

https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/working-with-forks/syncing-a-fork

Your fork is currently very outdated compared to Arduino's repository and that is causing the automated "Content Linter" check to fail. It should be as simple to do as clicking the button shown in the tutorial I linked above.

@MessiahJa
Copy link
Contributor Author

@per1234 I was making new changes at the same time as your corrections so I could not commit your suggestions since they became outdated. I corrected the spelling errors, shortened the title and added "proper" descriptions to all images. Thank you.

@per1234
Copy link
Contributor

per1234 commented May 14, 2022

You are welcome. I find GitHub's "suggestions" feature useful for unambiguous communication during PR reviews, but the PR author is always welcome to implement my suggestions however they like (if at all).

Please check the results of the latest CI run. There is good progress toward a ✔️, but still a few problems that will need to be resolved:

https://github.com/arduino/docs-content/runs/6434948735?check_suite_focus=true#step:3:9

./content/hardware/02.hero/boards/uno-rev3/tutorials/PWM-using-MATLAB-Tutorial/PWM-using-MATLAB-Tutorial.md:97: curcuit ==> circuit
./content/hardware/02.hero/boards/uno-rev3/tutorials/PWM-using-MATLAB-Tutorial/PWM-using-MATLAB-Tutorial.md:142: porcessed ==> processed
./content/hardware/02.hero/boards/uno-rev3/tutorials/PWM-using-MATLAB-Tutorial/PWM-using-MATLAB-Tutorial.md:142: ouput ==> output

https://github.com/arduino/docs-content/runs/6434948755?check_suite_focus=true#step:3:43

❌ ERROR: 'Connecting the board to MATLAB' is not title case. Location: ../../content/hardware/02.hero/boards/uno-rev3/tutorials/PWM-using-MATLAB-Tutorial/PWM-using-MATLAB-Tutorial.md:[45](https://github.com/arduino/docs-content/runs/6434948755?check_suite_focus=true#step:3:45):1
❌ ERROR: 'Programming the board' is not title case. Location: ../../content/hardware/02.hero/boards/uno-rev3/tutorials/PWM-using-MATLAB-Tutorial/PWM-using-MATLAB-Tutorial.md:101:1
❌ ERROR: Asset 'Arduino-Connect.png' is not used. Location: ../../content/hardware/02.hero/boards/uno-rev3/tutorials/PWM-using-MATLAB-Tutorial/PWM-using-MATLAB-Tutorial.md:1:1
❌ ERROR: Asset 'Arduino-Uno-LED.jpg' is not used. Location: ../../content/hardware/02.hero/boards/uno-rev3/tutorials/PWM-using-MATLAB-Tutorial/PWM-using-MATLAB-Tutorial.md:1:1
❌ ERROR: Asset 'arduinoproperties.png' is not used. Location: ../../content/hardware/02.hero/boards/uno-rev3/tutorials/PWM-using-MATLAB-Tutorial/PWM-using-MATLAB-Tutorial.md:1:1
❌ ERROR: Asset 'curcuit.jpg' is not used. Location: ../../content/hardware/02.hero/boards/uno-rev3/tutorials/PWM-using-MATLAB-Tutorial/PWM-using-MATLAB-Tutorial.md:1:1
❌ ERROR: Asset 'program-Arduino.png' is not used. Location: ../../content/hardware/02.hero/boards/uno-rev3/tutorials/PWM-using-MATLAB-Tutorial/PWM-using-MATLAB-Tutorial.md:1:1
❌ ERROR: Asset 'programming-done.png' is not used. Location: ../../content/hardware/02.hero/boards/uno-rev3/tutorials/PWM-using-MATLAB-Tutorial/PWM-using-MATLAB-Tutorial.md:1:1
❌ ERROR: Image doesn't have a (proper) description: assets/curcuit.png Location: ../../content/hardware/02.hero/boards/uno-rev3/tutorials/PWM-using-MATLAB-Tutorial/PWM-using-MATLAB-Tutorial.md:97:1

It will also be required for you to sign the contributor license agreement offered by the bot here:

#222 (comment)

@MessiahJa
Copy link
Contributor Author

@per1234 Is there any tutorial that could show me how I could use CI? I saw that the results do not update and it has to run again but I've not found any tutorials on it.

@per1234
Copy link
Contributor

per1234 commented May 14, 2022

Is there any tutorial that could show me how I could use CI

There is general information about it here:

https://docs.github.com/en/actions

However, that is only about the "GitHub Actions" framework the continuous integration system of this repository runs on. There isn't anything there specific to Arduino's own checks.

The "Spell Check" check that runs is from this excellent tool named codespell:

https://github.com/codespell-project/codespell

If you install that on your computer, you could run codespell on the projects yourself using a command like this:

codespell -I "scripts/resources/spell-check-ignore-list.txt" --skip="*.svg,*.dxf" ./content/

The "Content Linter" check is a custom tool created by Arduino and hosted here:

https://github.com/arduino/content-lint

I saw that the results do not update and it has to run again but I've not found any tutorials on it.

Unfortunately, there is nothing you can do about that. Arduino has configured the repository so that a maintainer must approve the CI runs for PRs from new contributors. That means there is an unfortunate delay between you pushing a new commit to the pull request and when one of the maintainers notice that an approval is required.

If you submit additional pull requests here after this one has been merged, the CI system will run the checks automatically.

@marqdevx
Copy link
Member

Should we close this PR? #193
@MessiahJa

@MessiahJa
Copy link
Contributor Author

@marqdevx If nothing is left to fix then yes! :D

@marqdevx marqdevx mentioned this pull request May 18, 2022
1 task
@marqdevx marqdevx added Tutorial community Bugs and fixes suggested by the community labels May 18, 2022
@jhansson-ard jhansson-ard requested a review from per1234 May 20, 2022 13:27
@jhansson-ard
Copy link
Contributor

@per1234 if you are happy with the tutorial now, could you please give an approving review? We are blocked from merging atm ⭐

Copy link
Contributor

@per1234 per1234 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't have any experience with MATLAB and don't possess a MATLAB license, so I am not able to fully evaluate the tutorial, but the parts I am able to evaluate look fine.

Thanks @MessiahJa!

@MessiahJa
Copy link
Contributor Author

@per1234 Thanks for your evaluation!

@marqdevx
Copy link
Member

@jhansson-ard Should we remake the pictures with an schematic view?

@marqdevx
Copy link
Member

Also I've tried to render it locally and everything seems good, no issues on the formatting side. ✔️

@marqdevx
Copy link
Member

@MessiahJa We are making some schematics pictures to replace the photos you took.

Also next week I will make some small changes, we will wait for your approval before merging it. 😄

@MessiahJa
Copy link
Contributor Author

Hello @marqdevx !
Is there anything I can do to help out with the changes and schematics? I have worked a lot on this and would love to see it included in the Arduino Docs. I'm working on a new one and want to have this merged before pulling the next tutorial.

@marqdevx
Copy link
Member

Sorry, I couldn't work on it yet.
I want just to make some small changes to fit our style guide, any major change.
I will jump on it ASAP

@MessiahJa
Copy link
Contributor Author

MessiahJa commented Jul 24, 2022

Its been more than a month since I last followed up. I put a lot of time and effort into creating this and was hoping to make a bunch more back to back but there has been no response from your team. @marqdevx

@jhansson-ard
Copy link
Contributor

Hey @MessiahJa!

We are currently in the middle of vacations, but Pablo will be back next week. I will make sure he takes a look at this PR so that we can merge it as soon as he is back.

Thank you for your patience 🙏🏼

MessiahJa and others added 20 commits August 23, 2022 12:14
…ATLAB-Tutorial/PWM-using-MATLAB-Tutorial.md

Co-authored-by: per1234 <accounts@perglass.com>
…ATLAB-Tutorial/PWM-using-MATLAB-Tutorial.md

Co-authored-by: per1234 <accounts@perglass.com>
…ATLAB-Tutorial/PWM-using-MATLAB-Tutorial.md

Co-authored-by: per1234 <accounts@perglass.com>
…ATLAB-Tutorial/PWM-using-MATLAB-Tutorial.md

Co-authored-by: per1234 <accounts@perglass.com>
…ATLAB-Tutorial/PWM-using-MATLAB-Tutorial.md

Co-authored-by: Pablo Marquínez Ferrándiz <pablomarqfer@gmail.com>
…ATLAB-Tutorial/PWM-using-MATLAB-Tutorial.md

Co-authored-by: Pablo Marquínez Ferrándiz <pablomarqfer@gmail.com>
…ATLAB-Tutorial/PWM-using-MATLAB-Tutorial.md

Co-authored-by: Pablo Marquínez Ferrándiz <pablomarqfer@gmail.com>
…ATLAB-Tutorial/PWM-using-MATLAB-Tutorial.md

Co-authored-by: Pablo Marquínez Ferrándiz <pablomarqfer@gmail.com>
…ATLAB-Tutorial/PWM-using-MATLAB-Tutorial.md

Co-authored-by: Pablo Marquínez Ferrándiz <pablomarqfer@gmail.com>
…ATLAB-Tutorial/PWM-using-MATLAB-Tutorial.md

Co-authored-by: Pablo Marquínez Ferrándiz <pablomarqfer@gmail.com>
…ATLAB-Tutorial/PWM-using-MATLAB-Tutorial.md

Co-authored-by: Pablo Marquínez Ferrándiz <pablomarqfer@gmail.com>
…ATLAB-Tutorial/PWM-using-MATLAB-Tutorial.md

Co-authored-by: Pablo Marquínez Ferrándiz <pablomarqfer@gmail.com>
…ATLAB-Tutorial/PWM-using-MATLAB-Tutorial.md

Co-authored-by: Pablo Marquínez Ferrándiz <pablomarqfer@gmail.com>
…ATLAB-Tutorial/PWM-using-MATLAB-Tutorial.md

Co-authored-by: Pablo Marquínez Ferrándiz <pablomarqfer@gmail.com>
…ATLAB-Tutorial/PWM-using-MATLAB-Tutorial.md

Co-authored-by: Pablo Marquínez Ferrándiz <pablomarqfer@gmail.com>
…ATLAB-Tutorial/PWM-using-MATLAB-Tutorial.md

Co-authored-by: Pablo Marquínez Ferrándiz <pablomarqfer@gmail.com>
…ATLAB-Tutorial/PWM-using-MATLAB-Tutorial.md

Co-authored-by: Pablo Marquínez Ferrándiz <pablomarqfer@gmail.com>
@marqdevx
Copy link
Member

I've changed the tutorial folder (the final link) to
https://docs.arduino.cc/tutorials/uno-rev3/ matlab-pwm-blink

Copy link
Member

@marqdevx marqdevx left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@MessiahJa content seems ready, im waiting for your confirmation 😄

@MessiahJa
Copy link
Contributor Author

https://docscontent-marqdevxcommunitymatlabpwmunop.gtsb.io/tutorials/uno-rev3/PWM-using-MATLAB-Tutorial

I'm having issues opening this page

@MessiahJa content seems ready, im waiting for your confirmation 😄

Cant wait, lets go.

@marqdevx
Copy link
Member

What does it say when you access the preview

Then lets merge 💪

@marqdevx marqdevx merged commit 8c5a50f into arduino:main Aug 24, 2022
@marqdevx
Copy link
Member

@MessiahJa It is public https://docs.arduino.cc/tutorials/uno-rev3/matlab-pwm-blink

It appears on both Uno R3 and UNO R3 SMD

Thanks for the contribution!! 😄

@MessiahJa
Copy link
Contributor Author

What does it say when you access the preview

It worked. Thank you very much for your help @jhansson-ard, @per1234 & @marqdevx

Serjlee pushed a commit that referenced this pull request Mar 1, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
community Bugs and fixes suggested by the community Tutorial
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants